Repository navigation
Lead the README with what the tool is, and fix the stale attribution text - #21
Merged
Merged
Conversation
…text Three changes, all needed before the first tagged release. Rewrite the top of the README. It opened with a wall of prose that made a reader work to find out what the tool does and offered no route to the two non-CLI ways of running it. It now leads with a centred title block and tagline, a Mermaid diagram of the six tests, a worked example, and a three-column table covering the CLI, the Claude/agent skill and the HELVE JSON-RPC tool -- so whichever way a reader arrived, their entry point is above the fold. The worked example is real output. Only the indented source-snippet line under each finding is removed, and the text says so rather than quietly reformatting the tool's output to look tidier than it is. Fix the attribution paragraph (closes #20). #13 described the attribution situation accurately when it was written; #15 then merged and changed it, leaving the README claiming the T2/T3/T6 tables "record no source at all, per entry or per table". They now carry a table-level `sources` block. The paragraph now states what is true: per-entry sources remain T1-only, the other tables carry provenance per table, and `--explain` surfaces neither yet -- linking #10, where that gap is tracked. Also drops the "where the repository root carries one" hedge on THIRD-PARTY-LICENSES.md, which is unconditionally present now. Add the 0.1.0 CHANGELOG section, covering the work that landed after the Unreleased block was written: the attribution files, the contributor docs, the wrapping regression suite, and the hard-wrap atomicity fix. Point the release workflow's environment URL at pypi.org/p/ste100-linter. The package is named ste100-linter in pyproject.toml; the URL said ste100, which is a different (also unclaimed) name. Cosmetic -- it only affects the link shown on the deployment -- but wrong. Verified: all eight suites pass, and `ste_lint.py README.md` now exits 0 with zero error-tier findings. Two findings this rewrite introduced were fixed rather than tolerated. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Release-night PR. Three things, all of which should land before the
v0.1.0tag.1. Rewrite the top of the README
The old opening was a wall of prose. A reader had to work to find out what the tool was, and there was no route to the two non-CLI ways of running it — they were buried in a
<details>block two thirds of the way down.The new top has:
dependencies: nonebadge, since that is the tool's main selling point)That last one is the point of the exercise: whichever way a reader arrived, their entry point is above the fold.
The example output is real
I originally hand-aligned the console block into neat columns. That was wrong — it made the tool's output look tidier than it is. It is now verbatim, with only the indented source-snippet line under each finding removed, and the prose says exactly that.
The Mermaid block deliberately avoids
<b>tags and other markup that some renderers drop. A broken diagram at the top of the front page on launch night is worse than a plain one.2. Fix the stale attribution paragraph — closes #20
#13 and #15 were written in parallel and merged in that order. #13's description of the attribution situation was accurate when written; #15 then changed the situation, leaving this on
main:The "per table" half is false — #15 added a
sourcesblock to all four files. The paragraph now says what is true: per-entry sources are still T1-only, the other tables carry provenance at table level, and--explainsurfaces neither yet, linking #10 where that is tracked.Also drops the "where the repository root carries one" hedge on
THIRD-PARTY-LICENSES.md. It is unconditionally present now and ships in the wheel.3. Release prep
[Unreleased]becomes[0.1.0] - 2026-08-25, with a fresh empty[Unreleased]above it. Added entries for the work that landed after that block was written — the attribution files, contributor docs, the wrapping regression suite, and the hard-wrap atomicity fix from Build sentence units from paragraphs, not from physical lines #12.release.yml: the environment URL pointed atpypi.org/p/ste100. The package isste100-linter. Cosmetic (it only affects the link on the deployment) but wrong.Verification
python ste_lint.py README.mdexits 0 with zero error-tier findings. The rewrite introduced two error-tier findings (requirement→need, and anIt isopener); both are fixed rather than tolerated.ste100-helve --helve-rpcactually starts and speaks JSON-RPC before documenting it, and matched the skill install snippet to the canonical steps on the wiki's Agent Skill page.Not in this PR
README.mdstill carries the "The package is not on PyPI yet" note under Install. That is accurate until the publish actually succeeds. It should be removed in a follow-up oncev0.1.0is live on PyPI — see the release checklist I posted separately.Closes #20